/*
 * Copyright 2012 Faculty of Informatics - Masaryk University.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.muni.fi.pa165.creatures.services;

import cz.muni.fi.pa165.creatures.dto.RegionDTO;
import java.util.List;

/**
 * This interface offers API for the implementation in order to be able execute
 * very basic crud-like operations upon
 * {@link cz.muni.fi.pa165.creatures.dto.RegionDTO}.
 *
 * @author hulek
 */
public interface RegionService {

    /**
     * This method creates a region.
     *
     * @param region region to create
     * @return id of the created region
     */
    Long create(RegionDTO region);

    /**
     * This method removes a region.
     *
     * @param region region to remove
     */
    void remove(RegionDTO region);

    /**
     * This method updates a region.
     *
     * @param region region to update
     */
    void update(RegionDTO region);

    /**
     * This method get region by its id.
     *
     * @param id id to get a region
     * @return region of specified {@code id}
     */
    RegionDTO getById(Long id);

    /**
     * This method gets all regions as a list of its DTOs.
     *
     * @return list of all regions ordered alphabetically by their name
     */
    List<RegionDTO> getAll();

    /**
     * This method returns count of regions.
     *
     * @return count of regions
     */
    Long getCount();

    /**
     * Deletes all regions.
     */
    void deleteAll();

    /**
     * Gets a region by its name.
     * @param name name of a region to get
     * @return region with a specified name
     */
    RegionDTO getByName(String name);
}
